home *** CD-ROM | disk | FTP | other *** search
/ PC World 2007 June / PCWorld_2007-06_cd.bin / temacd / wikipad / WikidPad-1.9beta2.exe / {app} / WikidPadHelp / data / Insertions.wiki < prev    next >
Encoding:
Text File  |  2006-12-23  |  3.5 KB  |  89 lines
  1. ∩╗┐++ Insertions
  2.  
  3. Insertions allow to insert some dynamic text into preview and HTML export of a page. This text can either be the content of another page or a list of wikipage links to pages which are parents or children of a page or to pages which form the result of a saved search.
  4.  
  5. To insert, for example, the content of the IncrementalSearch page, write:
  6.  
  7. [:page: IncrementalSearch]
  8.  
  9. ----
  10.  
  11. If you switch now to the preview, you will see the content of the IncrementalSearch page above, instead of the insertion tag.
  12.  
  13.  
  14. +++ Syntax
  15. The tag begins always with '[:' then comes the _insertion key_, then a colon and the _insertion value_,
  16. after that there may be appendices, separated by semicolons, to describe the way of presentation in more detail. The tag is closed by a closing bracket.
  17.  
  18. In the example above, "page" is the insertion key, "IncrementalSearch" is the value.
  19.  
  20. The value and appendices can be quoted (enclosed by quotation symbols) if they shall contain special characters or newlines. A quotation symbol is an arbitrary number of one of the quotation characters ", ', / or \ (double quotation mark, single quotation mark, slash or backslash). The starting and ending symbols must be the same. Examples for quotation symbols are:
  21.  
  22. "
  23. '''
  24. //
  25. /////
  26. \\
  27.  
  28. The above insertion example can therefore be written as:
  29.  
  30. <<
  31. [:page: "IncrementalSearch"]
  32. [:page: '''IncrementalSearch''']
  33. [:page: //IncrementalSearch//]
  34. [:page: /////IncrementalSearch/////]
  35. [:page: \\IncrementalSearch\\]
  36. >>
  37.  
  38. The following keys and values are possible:
  39.  
  40.     * *page* shows the content of the existing wiki page which is
  41.       given as insertion value.
  42.     * *rel* lists all wiki words related to this page in the way
  43.       described by the value:
  44.         * *parents*: all parents of the page
  45.         * *children*: all children (= all wiki links) of the page.
  46.           With appendix "existingonly" only the really existing
  47.           pages are listed
  48.         * *parentless*: all parentless pages. The list is
  49.           independent from the page containing the insertion tag.
  50.         * *undefined*: all undefined wiki word links. The list is
  51.           independent from the page containing the insertion tag.
  52.     * *savedsearch* lists all wiki words found by the saved search
  53.       with the name given as value.
  54.     * *toc* shows a little table of contents with the headings of 
  55.       the current page. In HTML preview/export you can click on the
  56.       the lines to go to the actual headings. The value of this
  57.       insertion must be empty.
  58.     * *eval* Evaluate the given Python expression and handle its
  59.       result as if it replaces the insertion. You must switch on
  60.       the appropriate option "Process insertion scripts" on the
  61.       "Security" options page to make it work.
  62.       
  63.  
  64. For insertion tags which produce lists of wiki links (all but the "page" and "eval" insertion), you can also have the appendices "columns 123" where 123 stands for the number of columns the list should have. By default, there is only one column.
  65.  
  66. +++ Examples
  67.  
  68. At first a few wiki links to demonstrate the functions: (KeyBindings, DeadLink, DeadLinkToo, ScratchPad, TextBlocks)
  69.  
  70. It is recommended to switch to preview to see the effect of the tags:
  71.  
  72. *\[:rel: parents]*
  73. [:rel: parents]
  74.  
  75. *\[:rel: children]*
  76. [:rel: children]
  77.  
  78. *\[:rel: children;existingonly;columns 2]*
  79. [:rel: children;existingonly;columns 2]
  80.  
  81. *\[:savedsearch: nanny; columns 4]*  (all pages containing "any")
  82. [:savedsearch: nanny; columns 4]
  83.  
  84. *\[:toc: ""]*
  85. [:toc: ""]
  86.  
  87. *\[:eval:"5+6"]*
  88. [:eval:"5+6"]
  89.